Skip to content

docs: restructure documentation, add CLI reference and workflows#4

Merged
montfort merged 2 commits intomainfrom
docs/restructure-and-versioning
Mar 19, 2026
Merged

docs: restructure documentation, add CLI reference and workflows#4
montfort merged 2 commits intomainfrom
docs/restructure-and-versioning

Conversation

@montfort
Copy link
Contributor

Summary

  • Add CLI-REFERENCE.md and WORKFLOWS.md for adopters (EN + ES) — fills the gap of missing CLI docs and daily usage patterns
  • Fix hardcoded v2.0.0 across 5 dist files and broken cookbook.md link in QUICK-REFERENCE.md
  • Update all docs to reflect independent fw-*/cli-* versioning scheme
  • Update releases/latest references to point users to fw-* tagged releases
  • Update CLI source tree in CONTRIBUTING.md (add update_framework.rs, status.rs)
  • Rewrite docs/README.md as a proper documentation hub with versioning section
  • Split framework/CLI versioning with independent release workflows

Test plan

  • Grep v2.0.0 in dist/ — 0 matches
  • Grep releases/latest across repo — 0 matches
  • Grep cookbook.md across repo — 0 matches
  • CLI commands table in README matches CLI-REFERENCE
  • All new files have language toggles linking EN ↔ ES
  • TRANSLATION-GUIDE scope includes new files

🤖 Generated with Claude Code

montfort and others added 2 commits March 18, 2026 23:00
Decouple framework and CLI release cycles so each component can evolve
independently. Framework uses `fw-*` tags, CLI uses `cli-*` tags, with
separate GitHub Actions workflows for each.

- Reset CLI version to 1.0.0, bump framework manifest to 2.1.0
- Add `get_latest_release_by_prefix()` to filter releases by tag prefix
- Add `strip_tag_prefix()` helper for fw-/cli-/v- prefixes
- Rename `update` command to `update-framework`, create combined `update`
- Add `update-framework` subcommand to CLI router
- Show both framework and CLI versions in `status` and `about`
- Split release.yml into release-framework.yml and release-cli.yml
- Update install scripts to fetch `cli-*` releases

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…rsion fixes

Add CLI-REFERENCE.md and WORKFLOWS.md for adopters (EN + ES), update all
docs to reflect independent fw-*/cli-* versioning, fix broken cookbook.md
link, remove hardcoded v2.0.0 from dist files, and update releases/latest
references to point to fw-* releases.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@montfort montfort merged commit e3f8e78 into main Mar 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants